/*
 *  Licensed to the Apache Software Foundation (ASF) under one or more
 *  contributor license agreements.  See the NOTICE file distributed with
 *  this work for additional information regarding copyright ownership.
 *  The ASF licenses this file to You under the Apache License, Version 2.0
 *  (the "License"); you may not use this file except in compliance with
 *  the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 */

package org.apache.coyote;

import java.util.concurrent.Executor;

/**
 * Abstract the protocol implementation, including threading, etc.
 * Processor is single threaded and specific to stream-based protocols,
 * will not fit Jk protocols like JNI.
 * <p>
 * This is the main interface to be implemented by a coyote connector.
 * Adapter is the main interface to be implemented by a coyote servlet
 * container.
 *
 * @author Remy Maucherat
 * @author Costin Manolache
 * @see Adapter
 */
public interface ProtocolHandler {

	public Adapter getAdapter();

	/**
	 * The adapter, used to call the connector.
	 */
	public void setAdapter(Adapter adapter);

	/**
	 * The executor, provide access to the underlying thread pool.
	 */
	public Executor getExecutor();

	/**
	 * Initialise the protocol.
	 */
	public void init() throws Exception;

	/**
	 * Start the protocol.
	 */
	public void start() throws Exception;

	/**
	 * Pause the protocol (optional).
	 */
	public void pause() throws Exception;

	/**
	 * Resume the protocol (optional).
	 */
	public void resume() throws Exception;

	/**
	 * Stop the protocol.
	 */
	public void stop() throws Exception;

	/**
	 * Destroy the protocol (optional).
	 */
	public void destroy() throws Exception;

	/**
	 * Requires APR/native library
	 */
	public boolean isAprRequired();
}
